// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期：2023-12-01 14:49:39
// 生成路径: api/v1/sms/plugin_sms_config.go
// 生成人：gfast
// desc:短信配置相关参数
// company:云南奇讯科技有限公司
// ==========================================================================

package sms

import (
	"github.com/gogf/gf/v2/frame/g"
	commonApi "github.com/tiger1103/gfast/v3/api/v1/common"
	"github.com/tiger1103/gfast/v3/internal/app/plugins/sms/model"
)

// PluginSmsConfigSearchReq 分页请求参数
type PluginSmsConfigSearchReq struct {
	g.Meta `path:"/list" tags:"插件接口/短信配置" method:"get" summary:"短信配置列表"`
	commonApi.Author
	model.PluginSmsConfigSearchReq
}

// PluginSmsConfigSearchRes 列表返回结果
type PluginSmsConfigSearchRes struct {
	g.Meta `mime:"application/json"`
	*model.PluginSmsConfigSearchRes
}

// PluginSmsConfigAddReq 添加操作请求参数
type PluginSmsConfigAddReq struct {
	g.Meta `path:"/add" tags:"插件接口/短信配置" method:"post" summary:"短信配置添加"`
	commonApi.Author
	*model.PluginSmsConfigAddReq
}

// PluginSmsConfigAddRes 添加操作返回结果
type PluginSmsConfigAddRes struct {
	commonApi.EmptyRes
}

// PluginSmsConfigEditReq 修改操作请求参数
type PluginSmsConfigEditReq struct {
	g.Meta `path:"/edit" tags:"插件接口/短信配置" method:"put" summary:"短信配置修改"`
	commonApi.Author
	*model.PluginSmsConfigEditReq
}

// PluginSmsConfigEditRes 修改操作返回结果
type PluginSmsConfigEditRes struct {
	commonApi.EmptyRes
}

// PluginSmsConfigGetReq 获取一条数据请求
type PluginSmsConfigGetReq struct {
	g.Meta `path:"/get" tags:"插件接口/短信配置" method:"get" summary:"获取短信配置信息"`
	commonApi.Author
	Id uint `p:"id" v:"required#主键必须"` //通过主键获取
}

// PluginSmsConfigGetRes 获取一条数据结果
type PluginSmsConfigGetRes struct {
	g.Meta `mime:"application/json"`
	*model.PluginSmsConfigInfoRes
}

// PluginSmsConfigDeleteReq 删除数据请求
type PluginSmsConfigDeleteReq struct {
	g.Meta `path:"/delete" tags:"插件接口/短信配置" method:"delete" summary:"删除短信配置"`
	commonApi.Author
	Ids []uint `p:"ids" v:"required#主键必须"` //通过主键删除
}

// PluginSmsConfigDeleteRes 删除数据返回
type PluginSmsConfigDeleteRes struct {
	commonApi.EmptyRes
}

type PluginsSmsConfigChangeStatusReq struct {
	g.Meta `path:"/changeStatus" tags:"插件接口/短信配置" method:"put" summary:"短信配置状态修改"`
	Id     uint `p:"id" v:"required#主键ID不能为空"`
	Status int  `p:"status" v:"required#状态不能为空"`
}

type PluginsSmsConfigChangeStatusRes struct {
	commonApi.EmptyRes
}
